docs/Board - CC3D.md

   1 # Board - CC3D
   2
   3 The OpenPilot Copter Control 3D aka CC3D is a board more tuned to Acrobatic flying or GPS based
   4 auto-piloting.  It only has one sensor, the MPU6000 SPI based Accelerometer/Gyro.
   5 It also features a 16Mbit SPI based EEPROM chip.  It has 6 ports labeled as inputs (one pin each)
   6 and 6 ports labeled as motor/servo outputs (3 pins each).
   7
   8 If issues are found with this board please report via the [github issue tracker](https://github.com/cleanflight/cleanflight/issues).
   9
  10 The board has a USB port directly connected to the processor.  Other boards like the Naze and Flip32
  11 have an on-board USB to uart adapter which connect to the processor's serial port instead.
  12
  13 The board cannot currently be used for hexacopters/octocopters.
  14
  15 Tricopter & Airplane support is untested, please report success or failure if you try it.
  16
  17 # Pinouts
  18
  19 The 8 pin RC_Input connector has the following pinouts when used in RX_PPM/RX_SERIAL mode
  20
  21 | Pin | Function  | Notes                            |
  22 | --- | --------- | -------------------------------- |
  23 | 1   | Ground    |                                  |
  24 | 2   | +5V       |                                  |
  25 | 3   | Unused |  |
  26 | 4   | SoftSerial1 TX / Sonar trigger | |
  27 | 5   | SoftSerial1 RX / Sonar Echo / RSSI_ADC    | Used either for SOFTSERIAL, SONAR or RSSI_ADC*. Only one feature can be enabled at any time. |
  28 | 6   | Current   | Enable `feature CURRENT_METER`.  Connect to the output of a current sensor, 0v-3.3v input |
  29 | 7   | Battery Voltage sensor | Enable `feature VBAT`. Connect to main battery using a voltage divider, 0v-3.3v input |
  30 | 8   | PPM Input | Enable `feature RX_PPM` |
  31
  32 *Connect to the output of a PWM-RSSI conditioner, 0v-3.3v input.
  33
  34 The 6 pin RC_Output connector has the following pinouts when used in RX_PPM/RX_SERIAL mode
  35
  36 | Pin | Function  | Notes |
  37 | --- | ----------| ------|
  38 | 1   | MOTOR 1   |       |
  39 | 2   | MOTOR 2   |       |
  40 | 3   | MOTOR 3   |       |
  41 | 4   | MOTOR 4   |       |
  42 | 5   | LED Strip |       |
  43 | 6   | Buzzer    |       |
  44
  45 The 8 pin RC_Input connector has the following pinouts when used in RX_PARALLEL_PWM mode
  46
  47 | Pin | Function | Notes |
  48 | --- | ---------| ------|
  49 | 1   | Ground   |       |
  50 | 2   | +5V      |       |
  51 | 3   | Unused   |       |
  52 | 4   | CH1      |       |
  53 | 5   | CH2      |       |
  54 | 6   | CH3      |       |
  55 | 7   | CH4/Battery Voltage sensor      | CH4 if battery voltage sensor is disabled |
  56 | 8   | CH5/CH4  | CH4 if battery voltage monitor is enabled|
  57
  58 The 6 pin RC_Output connector has the following pinouts when used in RX_PARALLEL_PWM mode
  59
  60 | Pin | Function | Notes |
  61 | --- | ---------| ------|
  62 | 1   | MOTOR 1  |       |
  63 | 2   | MOTOR 2  |       |
  64 | 3   | MOTOR 3  |       |
  65 | 4   | MOTOR 4  |       |
  66 | 5   | Unused   |       |
  67 | 6   | Unused   |       |
  68
  69 # Serial Ports
  70
  71 | Value | Identifier   | Board Markings | Notes                                     |
  72 | ----- | ------------ | -------------- | ------------------------------------------|
  73 | 1     | VCP          | USB PORT       |                                           |
  74 | 2     | USART1       | MAIN PORT      | Connected to an MCU controllable inverter |
  75 | 3     | USART3       | FLEX PORT      |                                           |
  76 | 4     | SoftSerial   | RC connector   | Pins 4 and 5 (Tx and Rx respectively)     |
  77
  78 The SoftSerial port is not available when RX_PARALLEL_PWM is used. The transmission data rate is limited to 19200 baud.
  79
  80 To connect the GUI to the flight controller you just need a USB cable to use the Virtual Com Port (VCP) or you can use UART1 (Main Port).
  81
  82 CLI access is only available via the VCP by default.
  83
  84 # Main Port
  85
  86 The main port has MSP support enabled on it by default.
  87
  88 The main port is connected to an inverter which is automatically enabled as required.  For example, if the main port is used for SBus Serial RX then an external inverter is not required.
  89
  90 # Flex Port
  91
  92 The flex port will be enabled in I2C mode unless USART3 is used.  You can connect external I2C sensors and displays to this port.
  93
  94 You cannot use USART3 and I2C at the same time.
  95
  96 ## Flex port pinout
  97
  98 | Pin | Signal             | Notes                   |
  99 | --- | ------------------ | ----------------------- |
 100 | 1   | GND                |                         |
 101 | 2   | VCC unregulated    |                         |
 102 | 3   | I2C SCL / UART3 TX | 3.3v level              |
 103 | 4   | I2C SDA / UART3 RX | 3.3v level (5v tolerant |
 104
 105
 106 # Flashing
 107
 108 There are two primary ways to get Cleanflight onto a CC3D board.
 109
 110 * Single binary image mode - best mode if you don't want to use OpenPilot.
 111 * OpenPilot Bootloader compatible image mode - best mode if you want to switch between OpenPilot and Cleanflight.
 112
 113 ## Single binary image mode.
 114
 115 The entire flash ram on the target processor is flashed with a single image.
 116
 117 The image can be flashed by using a USB to UART adapter connected to the main port when the CC3D is put into the STM32 bootloader mode, achieved by powering on the CC3D with the SBL/3.3v pads bridged.
 118
 119 ## OpenPilot Bootloader compatible image mode.
 120
 121 The initial section of flash ram on the target process is flashed with a bootloader which can then run the code in the
 122 remaining area of flash ram.
 123
 124 The OpenPilot bootloader code also allows the remaining section of flash to be reconfigured and re-flashed by the
 125 OpenPilot Ground Station (GCS) via USB without requiring a USB to uart adapter.
 126
 127 The following features are not available:
 128  * Display
 129  * Sonar
 130
 131 # Restoring OpenPilot bootloader
 132
 133 If you have a JLink debugger, you can use JLinkExe to flash the open pilot bootloader.
 134
 135 1. Run JLinkExe `/Applications/SEGGER/JLink/JLinkExe`
 136 2. `device STM32F103CB`
 137 3. `r`
 138 4. `h`
 139 5. `loadbin opbl.bin, 0x08000000`
 140 6. `q`
 141 7. Re-plug CC3D.
 142
 143 Here's an example session:
 144
 145 ```
 146 $ /Applications/SEGGER/JLink/JLinkExe
 147 SEGGER J-Link Commander V4.90c ('?' for help)
 148 Compiled Aug 29 2014 09:52:38
 149 DLL version V4.90c, compiled Aug 29 2014 09:52:33
 150 Firmware: J-Link ARM-OB STM32 compiled Aug 22 2012 19:52:04
 151 Hardware: V7.00
 152 S/N: -1
 153 Feature(s): RDI,FlashDL,FlashBP,JFlash,GDBFull
 154 VTarget = 3.300V
 155 Info: Could not measure total IR len. TDO is constant high.
 156 Info: Could not measure total IR len. TDO is constant high.
 157 No devices found on JTAG chain. Trying to find device on SWD.
 158 Info: Found SWD-DP with ID 0x1BA01477
 159 Info: Found Cortex-M3 r1p1, Little endian.
 160 Info: FPUnit: 6 code (BP) slots and 2 literal slots
 161 Info: TPIU fitted.
 162 Cortex-M3 identified.
 163 Target interface speed: 100 kHz
 164 J-Link>device STM32F103CB
 165 Info: Device "STM32F103CB" selected (128 KB flash, 20 KB RAM).
 166 Reconnecting to target...
 167 Info: Found SWD-DP with ID 0x1BA01477
 168 Info: Found SWD-DP with ID 0x1BA01477
 169 Info: Found Cortex-M3 r1p1, Little endian.
 170 Info: FPUnit: 6 code (BP) slots and 2 literal slots
 171 Info: TPIU fitted.
 172 J-Link>r
 173 Reset delay: 0 ms
 174 Reset type NORMAL: Resets core & peripherals via SYSRESETREQ & VECTRESET bit.
 175 J-Link>h
 176 PC = 0800010C, CycleCnt = 00000000
 177 R0 = 0000000C, R1 = 0000003F, R2 = 00000000, R3 = 00000008
 178 R4 = 00003000, R5 = 023ACEFC, R6 = 200000F0, R7 = 20000304
 179 R8 = 023B92BC, R9 = 00000000, R10= ED691105, R11= F626177C
 180 R12= 000F0000
 181 SP(R13)= 20000934, MSP= 20000934, PSP= 20000934, R14(LR) = FFFFFFFF
 182 XPSR = 01000000: APSR = nzcvq, EPSR = 01000000, IPSR = 000 (NoException)
 183 CFBP = 00000000, CONTROL = 00, FAULTMASK = 00, BASEPRI = 00, PRIMASK = 00
 184 J-Link>loadbin opbl.bin, 0x08000000
 185 Downloading file [opbl.bin]...
 186 WARNING: CPU is running at low speed (8004 kHz).
 187 Info: J-Link: Flash download: Flash download into internal flash skipped. Flash contents already match
 188 Info: J-Link: Flash download: Total time needed: 0.898s (Prepare: 0.709s, Compare: 0.128s, Erase: 0.000s, Program: 0.000s, Verify: 0.000s, Restore: 0.059s)
 189 O.K.
 190 J-Link>q
 191 $
 192 ```